home *** CD-ROM | disk | FTP | other *** search
/ Workbench Add-On / Workbench Add-On - Volume 1.iso / Dev / TileForth / doc / tile.txt < prev   
Text File  |  1995-08-25  |  10KB  |  265 lines
  1.  
  2.  
  3.  
  4.           TILE(1)                                                   TILE(1)
  5.  
  6.  
  7.           NAME
  8.                  tile   c  based forth-83 standard compiler and programming
  9.                  environment
  10.  
  11.           SYNOPSIS
  12.                  forth [dpru size] [file ...] [a argument ...]
  13.                  forth [dpru size] [file ...]  [s  start-symbol]  [argument
  14.                  ...]
  15.  
  16.           DESCRIPTION
  17.                  forth uses a command syntax much like a compiler. The file
  18.                  arguments are loaded before the interaction  top  loop  is
  19.                  started.  A  startsymbol  may also be given as an argument
  20.                  making  forth  act  as  a  `compile-and-go'  compiler   of
  21.                  applications.  Any  extra  options or parameters passed to
  22.                  forth may be accessed by the application. As extensions of
  23.                  the   Forth-83  Standard  forth  supports  floating  point
  24.                  numbers,  strings,  multi-tasking,   exceptions,   private
  25.                  definitions, argument binding and local variables and much
  26.                  more.  Written in C the kernel may be used  as  a  general
  27.                  purpose    environment   for   interactive   testing   and
  28.                  development of C-code.
  29.  
  30.                  To provide  an  interactive  programming  environment  for
  31.                  developing  programs  forth may be run as a sub-process to
  32.                  GNU Emacs in a specialized forthmode.  Source code may  be
  33.                  edited  and  directly tested by passing either a paragraph
  34.                  of code or  a  whole  buffer  to  forth  from  Emacs.  The
  35.                  forthmode   also   supports  documentation  retrieval  and
  36.                  automatic  indentation  of  forth   code,   comments   and
  37.                  definitions.
  38.  
  39.                  An  environment  variable  is  used to specify file search
  40.                  paths and support management of libraries of source  code.
  41.                  forth  compiles  faster  than  most  compilers  link  with
  42.                  approx. 70.000 lines per minute on a  SUN-3/60  (and  over
  43.                  200.000  on  a SUN-SPARCstation 1).  Code is only saved in
  44.                  source form.  Loading all  available  library  code  takes
  45.                  less than a second.
  46.  
  47.           OPTIONS
  48.                  ddictionary-size
  49.                         Size  of dictionary in bytes. Default allocation is
  50.                         1024K bytes.
  51.  
  52.                  pparameters-stack-size
  53.                         Size of foreground process parameter stack in cells
  54.                         (32-bits).  Default allocation is 256 cells.
  55.  
  56.                  rreturn-stack-size
  57.                         Size  of  foreground  process return stack in cells
  58.                         (32-bits).  Default allocation is 256 cells.
  59.  
  60.  
  61.  
  62.  
  63.  
  64.           Version 3.33             August 16, 1990                        1
  65.  
  66.  
  67.  
  68.  
  69.  
  70.           TILE(1)                                                   TILE(1)
  71.  
  72.  
  73.                  uuser-area-size
  74.                         Size of foreground  process  user  area  in  bytes.
  75.                         Default allocation is 1024 bytes.
  76.  
  77.                  a argument ...
  78.                         Allows  access  of  the  rest of the arguments. The
  79.                         first arguments is the string forth.
  80.  
  81.                  s start-symbol
  82.                         Defines the symbol to be used instead of the normal
  83.                         interaction  top-loop.  The startsymbol becomes the
  84.                         first argument and any  further  arguments  may  be
  85.                         accessed  by  the application. The library contains
  86.                         some examples of argument fetching functions.
  87.  
  88.           LIBRARIES
  89.                  The  tile   environment   consists   currently   of   five
  90.                  directories with C kernel source, forth-83 source library,
  91.                  test and example code,  manuals  and  documentation.   The
  92.                  directory  src  contains  all the C-level code and the GNU
  93.                  emacs programming environment.  The directory lib contains
  94.                  Forth-83  source  code  modules, consisting of a number of
  95.                  data modelling, and debugging tools, and high level multi-
  96.                  tasking   constructs   such   as   semaphores,   channels,
  97.                  rendezvous and task types.  Documentation  of  the  source
  98.                  code  and the kernel are found in the directory man and in
  99.                  the directory doc.  These  are  use  for  handling  manual
  100.                  commands   or  documentation  search  in  the  programming
  101.                  environment  (in  GNU  emacs).  Test  programs  for   each
  102.                  forth-83 source library code may be found in the directory
  103.                  tst.
  104.  
  105.           FILES
  106.                  file.f83            Forth-83 source input file
  107.                  file.tst            Forth-83 source test file
  108.                  file.3              Forth-83 source manual pages
  109.                  file.doc            Forth-83 source documentation file
  110.                  kernel.c..h..v      multi-tasking c based Forth-83  kernel
  111.                                      and extension vocabularies
  112.                  error.c..h          error management package
  113.                  io.c..h             multi-tasking input package
  114.                  memory.c..h         memory management package
  115.                  forth.c             this application
  116.                  forth.el            GNU Emacs forth-mode source
  117.                  tile.1              this manual
  118.                  Makefile            puts the forth application together
  119.  
  120.           ENVIRONMENT
  121.                  TILE                Path for the tile directory structure.
  122.                                      A normal setting for a single user  is
  123.                                      `$HOME/tile'.
  124.  
  125.                  TILEPATH            Search  path for library source files.
  126.                                      A       normal       setting        is
  127.  
  128.  
  129.  
  130.           Version 3.33             August 16, 1990                        2
  131.  
  132.  
  133.  
  134.  
  135.  
  136.           TILE(1)                                                   TILE(1)
  137.  
  138.  
  139.                                      `$TILE/lib:$TILE/tst' which will allow
  140.                                      the file include function in forth  to
  141.                                      locate  library  source  files  in the
  142.                                      current directory ($PWD), the standard
  143.                                      library,  and  the  test code library.
  144.                                      forth also looks  for  files  at  your
  145.                                      home directory ($HOME).
  146.  
  147.                  MANPATH             Search  path  for manual source files.
  148.                                      Used  by  man  for  access  of  manual
  149.                                      pages.    Setting   this   environment
  150.                                      variable to `$TILE/man:/usr/share/man'
  151.                                      will  allow  you  to  read  the  forth
  152.                                      manual pages.
  153.  
  154.           GNU EMACS FORTH MODE
  155.                  The GNU Emacs forth-mode supports interactive programming,
  156.                  automatic  indentation  of  source code, and documentation
  157.                  search of the forth kernel and library  within  Emacs.  To
  158.                  allow  automatic  loading  of  the  mode  your .emacs file
  159.                  should contain the following definitions;
  160.  
  161.                    (set-variable 'load-path
  162.                                  (append load-path
  163.                                          '(nil "~/tile")))
  164.                    (setq forth-help-load-path '(nil "~/tile/doc"))
  165.                    (setq auto-mode-alist
  166.                          (append '(("\\.tst$" . forth-mode)
  167.                                   ("\\.f83$" . forth-mode))
  168.                                   auto-mode-alist))
  169.                    (autoload 'forth-mode "forth")
  170.  
  171.                  Further documentation about the forthmode may be found  by
  172.                  giving the command `M-x describe-mode' in Emacs.
  173.  
  174.           BUGS
  175.                  Bugs  should  be  reported  to  mip@ida.liu.se.  Bugs tend
  176.                  actually to be fixed if they can be isolated, so it is  in
  177.                  your  interest  to report them in such a way that they can
  178.                  be easily reproduced according to get newer version.
  179.  
  180.           COPYING
  181.                  Copyright (C) 1989-90 Mikael R.K. Patel
  182.                  Permission is granted  to  make  and  distribute  verbatim
  183.                  copies  of  this  manual provided the copyright notice and
  184.                  this permission notice are preserved on all copies.
  185.                  Permission is granted  to  copy  and  distribute  modified
  186.                  versions  of this manual under the conditions for verbatim
  187.                  copying, provided also  that  the  section  entitled  "GNU
  188.                  General  Public  License"  is  included  exactly as in the
  189.                  original, and provided that the entire  resulting  derived
  190.                  work is distributed under the terms of a permission notice
  191.                  identical to this one.
  192.                  Permission is granted to copy and distribute  translations
  193.  
  194.  
  195.  
  196.           Version 3.33             August 16, 1990                        3
  197.  
  198.  
  199.  
  200.  
  201.  
  202.           TILE(1)                                                   TILE(1)
  203.  
  204.  
  205.                  of  this  manual  into  another  language, under the above
  206.                  conditions for modified versions, except that the  section
  207.                  entitled "GNU General Public License" may be included in a
  208.                  translation approved by  the  author  instead  of  in  the
  209.                  original English.
  210.  
  211.           AUTHORS
  212.                  Mikael R.K. Patel
  213.                  Computer Aided Design Laboratory (CADLAB)
  214.                  Department of Computer and Information Science
  215.                  Linkoping University
  216.                  S-581 83 LINKOPING
  217.                  SWEDEN
  218.                  Email: mip@ida.liu.se
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.           Version 3.33             August 16, 1990                        4
  263.  
  264.  
  265.